docs: create generated reference docs - #3053
Open
haleychaas wants to merge 7 commits into
Open
Conversation
Set up TypeDoc + typedoc-plugin-markdown to generate a Markdown API reference into docs/english/reference, mirroring node-slack-sdk. - Add typedoc/typedoc-plugin-markdown dev deps and a "docs" script; regenerate docs as part of the "version" script. - Add typedoc.json using node-slack-sdk's config, plus excludeExternals (avoids inlining the entire @slack/web-api and @slack/types surface) and excludeScopesInPaths (drops the @slack/ scope from output paths). - Rename the curated reference.md to interface-reference.md so the generated docs can own the "reference" slug; repoint anchor links. - Wire an autogenerated "Reference" category into _sidebar.json. - Add a "Build docs" CI step (Node 24.x only) to verify generation. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
The SlackAction type-alias comment contained raw generic syntax (SlackActionMiddlewareArgs<BlockAction<SomeNewAction>>) that TypeDoc copies verbatim into the generated Markdown. Docusaurus's MDX parser reads the unescaped `<` as a JSX tag and fails the docs-site build. Wrap the generic expressions in backticks (inline code) so they render literally, and regenerate the reference. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3053 +/- ##
=======================================
Coverage 94.33% 94.33%
=======================================
Files 43 43
Lines 7360 7360
Branches 679 679
=======================================
Hits 6943 6943
Misses 409 409
Partials 8 8 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
supports our pinned 5.3.3).
SlackActionMiddlewareArgs<...>) in a SlackAction JSDoc comment that broke the Docusaurus/MDX docs-site build; fixed at the source and regenerated.Preview here: https://docs-slack-d-docs-branc-syafbh.herokuapp.com/tools/bolt-js/
Requirements